docs: add Assets API documentation #743
Draft
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
- Add comprehensive Assets API section with list, upload, get, tags, delete - Add legacy note to existing /api/upload/* section - Recommend Assets API for new integrations Amp-Thread-ID: https://ampcode.com/threads/T-019c0c6f-94c9-70a9-90c7-dee4048a242d Co-authored-by: Amp <amp@ampcode.com>
Contributor
Author
|
Closing - will create a new PR for local ComfyUI server docs instead of cloud API |
- Add /api/assets endpoints to routes table with (recommended) label - Mark /upload/image, /upload/mask, /view as (legacy) - Add detailed Assets API section with parameters, response examples - Update both English and Chinese translations Amp-Thread-ID: https://ampcode.com/threads/T-019c0c6f-94c9-70a9-90c7-dee4048a242d Co-authored-by: Amp <amp@ampcode.com>
Amp-Thread-ID: https://ampcode.com/threads/T-019c0cd7-4eea-71d7-91d1-6b7288070d65 Co-authored-by: Amp <amp@ampcode.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Summary
Adds comprehensive documentation for the Assets API (
/api/assets) as the recommended approach for file management instead of legacy/api/upload/*and/api/viewendpoints.Changes
GET /api/assets- List assets with tag/name/metadata filteringPOST /api/assets- Upload assets with tags and metadataGET /api/assets/{id}- Get asset detailsPOST/DELETE /api/assets/{id}/tags- Manage asset tagsDELETE /api/assets/{id}- Delete assets/api/upload/*section as legacy with recommendation to use Assets APINote
This PR should be kept as draft until the ComfyUI
assets-api-implementationbranch is merged.Related
Notion ticket: COM-13971